home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / comm / mail / SpamBeGone.lha / INSTALL.AMIGA next >
Encoding:
Text File  |  1997-08-15  |  7.0 KB  |  182 lines
  1. Introduction
  2. ============
  3.  
  4. Spam Be Gone! is a program that uses machine learning to predict
  5. the priority of mail messages. As well as assigning spam messages
  6. a low priority, it can also assign high priority to messages that
  7. are likely to be of interest to you.  It is a standalone program
  8. that is designed to be integrated with your mailreader.  It
  9. requires three things to be any use:
  10.  
  11. 1) Some way of calling Spam Be Gone! for each new mail message.
  12. Ideally this would be as part of the mailreader, but there is a
  13. program on Aminet called Filter that can be used externally
  14. (that's what I use).
  15.  
  16. 2) Your mailreader should be able to either filter mail based on the
  17. X-Priority:  message header or allow sorting mail based on that
  18. header.
  19.  
  20. 3) The mailer should also allow Spam Be Gone! to be called
  21. by the user on demand to allow training (this is usually
  22. accomplished by an ARexx menu command). If this is not possible,
  23. Spam Be Gone! can be trained from the CLI (not a big hassle,
  24. because not a great deal of training is required)
  25.  
  26.  
  27. Installation of Spam Be Gone! (AMIGA)
  28. =====================================
  29.  
  30. 1. Copy the Spam Be Gone! executable somewhere. (In the examples
  31.    below, I've used Apps:Filter/). Spam Be Gone! requires that
  32.    the environment variables HOME and USER be set. HOME is the
  33.    directory where Spam Be Gone! will store it's config files,
  34.    and USER is your username (this should be the same as the
  35.    username in your key registration message).
  36.  
  37.  
  38. 2. Get your key registration message from 
  39.  
  40. http://www.internz.com/SpamBeGone/
  41.  
  42.  
  43. 3. Run Spam Be Gone on the registration message (key_msg),
  44.  
  45. Apps:Filter/SpamBeGone -r < key_msg 
  46.  
  47.    to update your key. The message should be copied to stdout 
  48.    along with a message saying a key was updated (if not, you
  49.    probably have a different username to the one your key works
  50.    for). You can also run SpamBeGone with the -h option to see 
  51.    what else SpamBeGone lets you do from the CLI.
  52.  
  53.  
  54. 4. Edit your $HOME/.sbg-config file as necessary. In general the 
  55.    keywords should be lowercase, and config identifiers
  56.    (like K+, K-, ADDRESSBOOK) are uppercase. We're contemplating
  57.    writing a standalone MUI application that will make this 
  58.    prettier)
  59.  
  60.    a) You should change/add positive and negative keywords.
  61.       Positive keywords are just as important as negative
  62.       keywords, because although spammers may try to avoid
  63.       the common negative keywords, they have no idea what
  64.       your interests (and thus your positive keywords) are.
  65.    b) You should set the location of your mailreader's
  66.       addressbook. If you don't have an addressbook you could
  67.       create a file (the default is .sbg-aliases) containing
  68.       email addresses of your friends.
  69.    c) You may wish to add more USER keywords (these indicate
  70.       that messages make reference to you or your friends
  71.       names directly).
  72.  
  73.  
  74. 5. Setup your system to pass incoming mail messages through
  75.    Spam Be Gone!. Ideally you'd want Spam Be Gone! to be called
  76.    directly by your mail reader for each incoming mail message. I use
  77.    Serious Voodoo, which doesn't allow this, so I use Filter
  78.    (from Aminet).
  79.  
  80.    Here's my setup:
  81.  
  82.    Mail arrives (by both SMTPd and AmiPOP) and gets stored in a
  83.    spoolfile (UUMAIL:trigg). Filter uses file notification to see
  84.    when new mail arrives there, and passes each message through
  85.    Spam Be Gone!, whos output gets appended to a new spool
  86.    file (UUMAIL:filtered). Voodoo is configured to get incoming
  87.    mail from UUMAIL:filtered rather than UUMAIL:trigg, and
  88.    automatically send messages with X-Priority: 5 to my garbage
  89.    folder.
  90.  
  91.    My .filterrc file looks like this:
  92.  
  93. #?
  94. COMMAND:Apps:Filter/SpamBeGone.sh
  95.  
  96.    SpamBeGone.sh is a short shell script that just calls Spam Be
  97.    Gone! with the right parameters, and appends the output of Spam
  98.    Be Gone to the new spoolfile. It should be possible to just
  99.    put the equivalent line directly in the .filterrc, but for some 
  100.    completely unexplained reason the temporary mail files filter 
  101.    creates are only visible to SpamBeGone if it's run from inside 
  102.    the script.
  103.    
  104. .key FILE/A
  105. .bra {
  106. .ket }
  107. Apps:Filter/SpamBeGone >>UUMAIL:Filtered -r <{FILE}
  108.  
  109.  
  110.    If you use a mail reader that does POP'ing internally (like YAM)
  111.    then something else will have to be done. My friend who uses YAM
  112.    has the unix version of Spam Be Gone! make the predictions as the
  113.    mail arrives at his unix account. If this isn't an option for you,
  114.    some friendly soul will have to write an ARexx script to get Spam 
  115.    Be Gone to predict the priority (use the -p option) after your 
  116.    mailreader gets the new mail.  Alternatively you could nicely ask 
  117.    the author of your mailreader to either implement piping messages
  118.    through programs on arrival or talk to us about integrating a 
  119.    library/plugin version of Spam Be Gone! into the mailer.
  120.  
  121.    
  122. 6. Initially train Spam Be Gone! on around 20 messages with 
  123.    a variety of priorities (ranging from 1 to 5), eg from the CLI:
  124.  
  125. Apps:Filter/SpamBeGone -t 5 < spammy.msg
  126. Apps:Filter/SpamBeGone -t 1 < important.msg
  127.  
  128.    Ideally you'd like to be able to do this from inside your
  129.    mailreader as well. Voodoo currently doesn't let me, but my friend 
  130.    who uses YAM has the following simple ARexx script to do it. 
  131.    Make 5 copies with suitably named files (like "Train--Priority-5"),
  132.    with the number after -t changing for each one. You may have
  133.    to give the full location of SpamBeGone if it isn't in your path.
  134.    You can then call the appropriate script from within YAM to
  135.    train on the current message. (The actual script my friend has
  136.    uses rsh to connect to the unix machine where he runs Spam Be Gone!
  137.    and train on the message there.)
  138.  
  139. /* Train Spam Be Gone! */
  140. OPTIONS RESULTS
  141. ADDRESS YAM
  142. getMailInfo FILE
  143. ADDRESS COMMAND 'SpamBeGone -t 5 <' || RESULT
  144.  
  145.  
  146.  
  147. General Use
  148. ===========
  149.  
  150.  
  151. Sit back and see what priorities Spam Be Gone! predicts in 
  152. the X-Priority: header of your mail messages. You may
  153. be able to configure your mailreader to sort incoming
  154. mail messages based on their priority, or to automatically
  155. send messages with very low priority to a junk folder (that's
  156. what I do with Voodoo).
  157.  
  158. You should only have to train Spam Be Gone! on messages that
  159. you think it made a wrong prediction on. If the prediction
  160. is acceptable, no training is required. For example, if
  161. Spam Be Gone! assigns a high priority to a spam message,
  162. train Spam Be Gone! so that next time a similar message
  163. arrives it will make the right prediction. Similarly for
  164. messages that Spam Be Gone mistakenly assigns a low priority
  165. to. You might also want to review the message to see whether 
  166. it contains keywords (either positive or negative) that
  167. could be added to your $HOME/.sbg-config file (in this case you
  168. you may not need to train on the message as well, run
  169.  
  170. Apps:Filter/SpamBeGone -s < msg
  171.  
  172. and see if the new prediction is better. If not, train on
  173. the message as well.
  174.  
  175.  
  176. Let us know if you like Spam Be Gone!, have any suggestions
  177. (particularly installation instructions for other mailreaders, 
  178. so we can share them with other users), or (gasp!) bug reports at 
  179. sbg-support@internz.co.nz
  180.  
  181.  
  182.